View Javadoc

1   package org.apache.torque.task;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.apache.tools.ant.Task;
23  import org.apache.velocity.util.StringUtils;
24  
25  /***
26   * Simple task to convert packages to paths.
27   *
28   * @author <a href="mailto:stephenh@chase3000.com">Stephen Haberman</a>
29   * @version $Id: PackageAsPathTask.java 473814 2006-11-11 22:30:30Z tv $
30   */
31  public class PackageAsPathTask extends Task
32  {
33  
34      /**</package-summary/html">The package to convert/ *//package-summary.html">em>* The package to convert. */
35      protected String pckg;
36  
37      /*** The value to store the conversion in. */
38      protected String name;
39  
40      /***
41       * Executes the package to patch converstion and stores it
42       * in the user property <code>value</code>.
43       */
44      public void execute()
45      {
46          super.getProject().setUserProperty(this.name,
47                  StringUtils.getPackageAsPath(this.pckg));
48      }
49  
50      /***
51       * @param pckg the package to convert
52       */
53      public void setPackage(String pckg)
54      {
55          this.pckg = pckg;
56      }
57  
58      /***
59       * @param name the Ant variable to store the path in
60       */
61      public void setName(String name)
62      {
63          this.name = name;
64      }
65  }